home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / disk / misc / catch100.lha / CatchDisk / English / Documentation / CatchDisk.doc < prev   
Encoding:
Text File  |  1993-10-17  |  10.0 KB  |  297 lines
  1.  
  2.  
  3.  
  4. -------------------------------------------------------------------------------
  5.                              CatchDisk: User Guide                             
  6. -------------------------------------------------------------------------------
  7.  
  8.  ------------------------------------------------------------------------------
  9.                        CatchDisk version 1.00 16-Oct-1993
  10.                       Copyright © 1993 By Alessandro Sala
  11.  
  12.  
  13.                Requires AmigaOS v2.04 ( Kickstart v37 ) or later
  14.              and WBStart-Handler v1.4 or later (by Stefan Becker)
  15.  ------------------------------------------------------------------------------
  16.  
  17.  
  18.                                     Contents
  19.  
  20.  
  21.                         - Legal info              
  22.                         - The distribution archive
  23.                         - Introduction
  24.                             What is CatchDisk ?   
  25.                             Installation          
  26.                         - Configuration and usage 
  27.                         - Terminating CatchDisk   
  28.                         - Contact Addresses       
  29.                         - Revision history        
  30.  
  31.  
  32.  
  33. ----------
  34. Legal info
  35. ----------
  36.  
  37.                                   ------------
  38.                                    Disclaimer
  39.                                   ------------
  40.  
  41.  
  42.    This program is provided "as is" without warranty of any kind, either
  43. expressed or implied, including, but not limited to, the implied warranty
  44. of fitness for a particular purpose.  Though every care has been taken to
  45. make this program system-friendly and bugs-free, the entire risk as to the
  46. results, reliability and performance of this program is assumed by you.
  47.  
  48.  
  49.  
  50.                                ------------------
  51.                                 Copyright notice
  52.                                ------------------
  53.  
  54.  
  55.    This program is "FreeWare": it can be freely copied and distributed for
  56. non-commercial purposes, provided that no file is added to or removed from the
  57. distribution archive and no charge, beside a nominal fee, is requested.
  58.    Nevertheless the program remains COPYRIGHT of the Author: you cannot
  59. patch, reverse engineer or otherwise modify the program, the documentation and
  60. every other file found in the distribution archive except where explicitly
  61. allowed.
  62.    Compressing in executable form is allowed for personal use but not
  63. for distribution: LHARC'ing in an archival form is explicitly allowed for
  64. distribution convenience.
  65.    Furthermore you cannot embed the program in any other software without
  66. the written permission of the author.
  67.  
  68.  
  69.  
  70. ------------------------
  71. The distribution archive
  72. ------------------------
  73.  
  74.  
  75.                       ------------------------------------
  76.                       Contents of the distribution archive
  77.                       ------------------------------------
  78.  
  79.  
  80.     CatchDisk           : The main program
  81.     CatchDisk.info      : Related '.info' file with pre-set tooltypes
  82.  
  83.  
  84.     Italiano
  85.       Leggimi           : General information in italian language
  86.       Documentazione
  87.         CatchDisk.doc   : Italian documentation in ASCII format
  88.         CatchDisk.guide : Italian documentation in AmigaGuide format
  89.       Installazione
  90.         Installa        : Installation program in italian language (see Leggimi)
  91.  
  92.  
  93.     English
  94.       Readme            : General information in english language
  95.       Documentation
  96.         CatchDisk.doc   : English documentation in ASCII format
  97.         CatchDisk.guide : English documentation in AmigaGuide format
  98.       Installation
  99.         Install         : Installation program in english language (see Readme)
  100.  
  101.  
  102.     Catalogs
  103.       CatchDisk.ct        : Empty translation file
  104.       italiano
  105.         CatchDisk.catalog : Italian language support file
  106.  
  107.  
  108.     Various '.info' files
  109.  
  110.  
  111.  
  112. ------------
  113. Introduction
  114. ------------
  115.  
  116.  
  117.                                What is CatchDisk ?
  118.                                ------------------
  119.  
  120.  
  121. CatchDisk is a simple commodity: its purpouse is to detect when a new disk
  122. is inserted in any drive and check if it is properly formatted: if not,
  123. CatchDisk executes the Format program with the drive, in which the disk was
  124. inserted, already selected. The user has only to choose the format options and
  125. start or abort the operation.
  126.  
  127.  
  128.                                    IMPORTANT
  129.                                    ---------
  130. To use CatchDisk you must have the WBStart-Handler in you L: directory. You
  131. need VERSION 1.4 OR LATER of the handler. WBStart-Handler is a freely
  132. distributable software by Stefan Becker: you can find it as 'WBStart1_4.lha'
  133. in many FTP sites or from PD distributors. Please note that the version
  134. required is at least v1.4, because previous versions had problems when dealing
  135. with null locks.
  136.  
  137.  
  138.  
  139.  
  140.  
  141.                                   Installation
  142.                                   ------------
  143.  
  144.  
  145.    To install CatchDisk, if you have the 'Installer' utility from Commodore (see
  146. Readme), you can simply double-click the 'Install' icon found in the 'English'
  147. drawer.
  148.    Differently, you can simply copy CatchDisk in some drawer, typically
  149. your SYS:WBStartup drawer. If you have OS 2.1 or later and you want to
  150. take advantage of localization, you must also copy the 'catalogs' drawer, found
  151. in the CatchDisk distribution archive, into the same drawer as CatchDisk, or
  152. you can copy the 'CatchDisk.catalog' file ( found in the 'catalogs/<language>/'
  153. drawer ) into your 'LOCALE:catalogs/<language>/' drawer.
  154.    If your language is not currently available, you can fill in the empty
  155. translation file found in the catalogs drawer ( catalogs/CatchDisk.ct ) and
  156. send it to me by E-Mail ( see the Contact Addresses section ). I will
  157. create a new '<your-language>/CatchDisk.catalog' file and E-Mail it to you as
  158. soon as possible, and the next version of CatchDisk will support one more
  159. language. You can also translate the documentation files and send them to me
  160. for inclusion in the distribution of CatchDisk.
  161. You must also have WBStart-Handler in you L: directory for CatchDisk to work
  162. (see 'What is CatchDisk'.)
  163.  
  164.  
  165.  
  166. -----------------------
  167. Configuration and usage
  168. -----------------------
  169.  
  170.  
  171.  
  172.   To start CatchDisk simply double-click its icon or type 'run CatchDisk' from
  173. a CLI. To have it activated on every bootstrap, place it in your SYS:WBStartup
  174. drawer with the 'DONOTWAIT' tooltype, or insert 'run CatchDisk' in your
  175. S:user-startup file.
  176.   CatchDisk recognizes the following ToolTypes or CLI arguments:
  177.  
  178.  
  179.           CX_PRIORITY=<pri>     : The priority of CatchDisk in the commodities
  180.                                   network.
  181.                                   Default value = 0. Range = -128 to 127
  182.  
  183.  
  184.           DEVICE<n>=<drive>     : It describes a group of alternative drives
  185.                                     for a single physical drive.
  186.                                     The number <n> identifies the group of
  187.                                     alternative drives, and can range from 0
  188.                                     to 9.
  189.                                     The <drive> parameter is the name of a
  190.                                     drive followed by ':', and you can list
  191.                                     any number of drives, without in-between
  192.                                     spaces.
  193.                                   Example:
  194.                                         'DEVICE0=DF0:PC0:'
  195.                                     tells CatchDisk that for a disk to be
  196.                                     considered properly formatted, it must be
  197.                                     readable accessing the drive as 'DF0:' or
  198.                                     as 'PC0:'.
  199.                                     If neither can read the disk, it will be 
  200.                                     formatted as 'DF0:' (the first drive in the
  201.                                     list).
  202.                                   If you specify instead:
  203.                                         'DEVICE0=PC0:DF0:'
  204.                                     if the disk in unreadable it will be
  205.                                     formatted as'PC0:'.
  206.                                   If one or more of the specified drives is not
  207.                                     mounted, it will be simply ignored.
  208.  
  209.  
  210.  
  211.           BREAK_WARN            : When CatchDisk terminates because of a
  212.                                   ^C signal, it displays a requester
  213.                                   informing you of the event only if BREAK_WARN
  214.                                   is set.
  215.  
  216.  
  217.    Once CatchDisk is active you can use the Commodities Exchange program to
  218. control its activities.
  219.  
  220.  
  221.  
  222. ---------------------
  223. Terminating CatchDisk
  224. ---------------------
  225.  
  226.  
  227.  
  228. As a commodity, CatchDisk can be terminated in three ways:
  229.  
  230.  
  231.   a) Run CatchDisk a second time.
  232.  
  233.  
  234.   b) Use the Commodities Exchange program.
  235.  
  236.  
  237.   c) Send CatchDisk a 'control-C' signal (see also BREAK_WARN):
  238.  
  239.  
  240.     c.1) If you started CatchDisk from workbench (or WBStartup drawer) use a
  241.          task control utility such as TaskX by Steve Tibbet.
  242.  
  243.  
  244.     c.2) If you started CatchDisk from a CLI (or user-startup) do the following:
  245.  
  246.  
  247.           1) Open a CLI
  248.           2) Issue the 'STATUS' command and note the process number of CatchDisk
  249.           3) Issue 'BREAK <n> C' where <n> is the process number noted above
  250.  
  251.  
  252.  
  253. -----------------
  254. Contact Addresses
  255. -----------------
  256.  
  257.  
  258.                            Criticism and suggestions
  259.                            -------------------------
  260.  
  261.  
  262.    I hope you will find CatchDisk useful, and if you have any criticism,
  263. suggestions, bug report, ideas for enhancements in possible future versions,
  264. you can write ( in Italian or English ) at the following address:
  265.  
  266.  
  267.         Alessandro Sala
  268.         Via A. Grandi, 16
  269.         20014 Nerviano (MI)
  270.         Italy
  271.  
  272.  
  273.     If you have E-Mail capability you can also contact me at the following
  274. Internet address (at least until the end of January 1994):
  275.  
  276.  
  277.         tser1506@cdc835.cdc.polimi.it
  278.  
  279.  
  280.  
  281. ----------------
  282. Revision history
  283. ----------------
  284.  
  285.  
  286. **********************************************************************************
  287.                                     History
  288. **********************************************************************************
  289.  
  290.  
  291. ------------
  292. Version 1.00
  293. ------------
  294.  
  295.  
  296.      First release.
  297.